﻿' ******************************************************************************
' ** 
' **  Yahoo Finance Managed
' **  Written by Marius Häusler 2010
' **  It would be pleasant, if you contact me when you are using this code.
' **  Contact: YahooFinanceManaged@gmail.com
' **  Project Home: http://code.google.com/p/yahoo-finance-managed/
' **  
' ******************************************************************************
' **  
' **  Copyright 2010 Marius Häusler
' **  
' **  Licensed under the Apache License, Version 2.0 (the "License");
' **  you may not use this file except in compliance with the License.
' **  You may obtain a copy of the License at
' **  
' **    http://www.apache.org/licenses/LICENSE-2.0
' **  
' **  Unless required by applicable law or agreed to in writing, software
' **  distributed under the License is distributed on an "AS IS" BASIS,
' **  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
' **  See the License for the specific language governing permissions and
' **  limitations under the License.
' ** 
' ******************************************************************************


Namespace Finance

    ''' <summary>
    ''' Stores information about a search result. Implements IID. Serializable. 
    ''' </summary>
    ''' <remarks></remarks>
    <Serializable()> _
    Public Class IDSearchResult
        Implements IID

        Private mType As FinancialSecurityType = FinancialSecurityType.Any
        Private mName As String = String.Empty
        Private mID As String = String.Empty
        Private mExchange As String = String.Empty
        Private mIndustryName As String = String.Empty
        Private mISIN As String = String.Empty
        Private mWKN As String = String.Empty

        ''' <summary>
        ''' The ID of the stock, index, etc.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks>Not ReadOnly because of implementing IID interface. Setting the ID value has no consequences.</remarks>
        Public ReadOnly Property ID() As String Implements IID.ID
            Get
                Return mID
            End Get
        End Property
        ''' <summary>
        ''' The name of the stock, index, etc.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public ReadOnly Property Name() As String
            Get
                Return mName
            End Get
        End Property
        ''' <summary>
        ''' The stock exchange of the stock, index, etc.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public ReadOnly Property Exchange() As String
            Get
                Return mExchange
            End Get
        End Property
        ''' <summary>
        ''' The industry name of the stock, index, etc.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public ReadOnly Property IndustryName() As String
            Get
                Return mIndustryName
            End Get
        End Property
        ''' <summary>
        ''' The type of the stock, index, etc.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public ReadOnly Property Type() As FinancialSecurityType
            Get
                Return mType
            End Get
        End Property
        Public ReadOnly Property ISIN() As String
            Get
                Return mISIN
            End Get
        End Property
        Public ReadOnly Property WKN() As String
            Get
                Return mWKN
            End Get
        End Property

        Friend Sub New(ByVal name As String, ByVal id As String, ByVal type As String, ByVal exchange As String, ByVal category As String, ByVal isin As String, ByVal wkn As String)
            mName = name
            mID = id
            mIndustryName = category
            mExchange = exchange
            Select Case type.ToLower
                Case "etf" : mType = FinancialSecurityType.ETF
                Case "mutual fund" : mType = FinancialSecurityType.Fund
                Case "future" : mType = FinancialSecurityType.Future
                Case "index" : mType = FinancialSecurityType.Index
                Case "stock" : mType = FinancialSecurityType.Stock
                Case "adr" : mType = FinancialSecurityType.ADR
                Case Else
                    If type.ToLower.IndexOf("aktie") > -1 Then : mType = FinancialSecurityType.Stock
                    ElseIf type.ToLower.IndexOf("future") > -1 Then : mType = FinancialSecurityType.Future
                    ElseIf type.ToLower.IndexOf("fond") > -1 Then : mType = FinancialSecurityType.Fund
                    ElseIf type.ToLower.IndexOf("fund") > -1 Then : mType = FinancialSecurityType.Fund
                    ElseIf type.ToLower.IndexOf("anleihe") > -1 Then : mType = FinancialSecurityType.Bond
                    ElseIf type.ToLower.IndexOf("option") > -1 Then : mType = FinancialSecurityType.OptionType
                    Else
                        mType = FinancialSecurityType.Any
                    End If
            End Select
            mISIN = isin
            mWKN = wkn
        End Sub

    End Class

End Namespace
